/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at legal/OPEN-SOURCE-LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.web.config.serverbeans;

import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.Element;

/**
 * Corresponds to the context-param element for customizing the configuration
 * of web apps.
 * 
 * @author tjquinn
 */
@Configured
public interface ContextParam extends ConfigBeanProxy {
    
    /**
     * Returns the context-param description.
     * @return description
     */
    @Element
    public String getDescription();
    
    /**
     * Sets the context-param description.
     * @param value new description value
     */
    public void setDescription(String value);
    
    /**
     * Returns the context-param parameter name.
     * @return parameter name
     */
    @Element(required=true,key=true)
    public String getParamName();
    
    /**
     * Sets the context-param parameter name.
     * @param value
     */
    public void setParamName(String value);
    
    /**
     * Returns the context-param parameter value.
     * @return parameter value
     */
    @Element
    public String getParamValue();
    
    /**
     * Sets the context-param parameter value.
     * @param value new value
     */
    public void setParamValue(String value);

    @Attribute(dataType=Boolean.class, defaultValue="false")
    public String getIgnoreDescriptorItem();
    public void setIgnoreDescriptorItem(String value);

}
